home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dskut / ramlt10.zip / ramlight.doc < prev   
Text File  |  1993-04-11  |  28KB  |  612 lines
  1. RAMLIGHT 1.0 DOCUMENTATION
  2. ==========================
  3. James W. Birdsall
  4. 04/11/93
  5.  
  6.  
  7. 0. CONTENTS
  8. -----------
  9.    0.      CONTENTS
  10.    1.      INTRODUCTION
  11.     1.1     Requirements
  12.     1.2     Quick Reference
  13.     1.3     Copyright, License, and Warranty Disclaimer
  14.    2.      USAGE
  15.     2.1     Monitoring drives
  16.      2.1.1   Unmonitorable drives
  17.     2.2     Options
  18.      2.2.1   -u Uninstall
  19.      2.2.2   -t Text mode
  20.      2.2.3   -? Help
  21.    3.      SPECIAL CONSIDERATIONS
  22.     3.1     Installing
  23.     3.2     Uninstalling
  24.     3.3     Hercules graphics, text pages
  25.     3.4     RAMLIGHT and UMBs
  26.     3.5     AMIS
  27.     3.6     Text mode list
  28.    4.      THE END
  29.  
  30.  
  31. 1. INTRODUCTION
  32. ---------------
  33.  
  34.    RAMLIGHT is a TSR which provides an activity indicator for ramdisks
  35. in the form of a blinking rectangle in the upper right corner of the
  36. screen. Whenever any access is made to a drive that is being monitored,
  37. whatever is currently in that position is replaced with a bright white
  38. rectangle; approximately one-tenth of a second later, the previous
  39. contents are restored. Each access resets the timer, so if additional
  40. accesses are made while the white rectangle is on the screen, it will
  41. not be removed until approximately one-tenth of a second after the last
  42. access.
  43.  
  44.    Be sure to read section 3, SPECIAL CONSIDERATIONS, so that you know
  45. how to use RAMLIGHT safely.
  46.  
  47.  1.1 Requirements
  48.  ----------------
  49.  
  50.    RAMLIGHT requires DOS version 2.0 or better.
  51.  
  52.    RAMLIGHT requires 848 bytes of conventional memory when monitoring
  53. one drive, and an additional 48 bytes for each additional drive
  54. monitored. RAMLIGHT does not use EMS or any sort of extended memory. It
  55. requires about 11K of conventional memory while installing itself.
  56.  
  57.  1.2 Quick Reference
  58.  -------------------
  59.  
  60.     This is a quick summary of the usage and options of RAMLIGHT.
  61. Invoking RAMLIGHT with the option "-?" will produce a similar summary.
  62. Complete explanations may be found in section 2.
  63.  
  64.    usage: ramlight [options] drive: [drive: ...]
  65.  
  66.         drive       Drive letter of a disk to be monitored, followed by
  67.                      a colon. At least one drive letter must be
  68.                      specified, except when the -u option is used.
  69.  
  70.         -u          UNINSTALL: If RAMLIGHT is installed, uninstall if
  71.                      possible, disable otherwise.
  72.  
  73.         -tmm[,cc[,s]]
  74.                     The activity indicator can only be provided in text
  75.                      modes. This option allows the user to specify
  76.                      nonstandard text modes. 'mm' is the mode number, in
  77.                      decimal. 'cc' is the number of columns; if not
  78.                      present, it defaults to 80. 's' is a letter
  79.                      indicating where the video memory is located for
  80.                      that mode:
  81.                         C = color text (B800)
  82.                         M = monochrome text (B000)
  83.                         G = graphics (A000)
  84.                      If not present, it defaults to C. Note that this
  85.                      option is not necessary for the common 80x43 and
  86.                      80x50 modes; settings for various popular cards are
  87.                      listed in section 3.6 below. Note that if RAMLIGHT
  88.                      is installed when the display is in a nonstandard
  89.                      mode, it will do nothing until the mode is changed
  90.                      to one that RAMLIGHT recognizes, unless an
  91.                      appropriate -t option has been given.
  92.  
  93.         -?          Prints this usage message.
  94.  
  95.    Options are case-insensitive, and may not be combined.
  96.  
  97.  1.3 Copyright, License, and Warranty Disclaimer
  98.  -----------------------------------------------
  99.  
  100.    RAMLIGHT is not in the public domain. All the files are copyright
  101. 1993 by James W. Birdsall, all rights reserved.
  102.  
  103.    Permission is granted to do the following:
  104.  
  105.         You may freely redistribute this archive, so long as it contains
  106.         all the files listed in the file MANIFEST, intact and
  107.         unmodified.
  108.  
  109.         You may use the programs contained in this archive freely. You
  110.         are encouraged to notify the author that you are using RAMLIGHT
  111.         so that you may receive update notices and bug reports, but no
  112.         registration fee is required.
  113.  
  114.    Source code is available for a $5 fee. Users may modify the source
  115. code for their own private use, but may not distribute modified copies
  116. or other software incorporating RAMLIGHT code without permission of the
  117. author.
  118.  
  119.    The contents of the distribution archive, and all other related
  120. files, information, and services are provided "as is" and without
  121. warranty. To the extent permitted by applicable law, the author
  122. disclaims all warranties, express or implied, including but not limited
  123. to, any implied warranty of merchantability or fitness for a particular
  124. purpose. While effort has been made to ensure that the files,
  125. information, and services are accurate and correct, the author shall not
  126. be liable for damages arising out of the use of or inability to use this
  127. product, including but not limited to, loss of profit, data, or use of
  128. this software, or special, incidental, or consequential damages or other
  129. similar claims, even if the author has been specifically advised of the
  130. possibility of such damages. Some states do not allow the exclusion of
  131. incidental or consequential damages, so the foregoing limitation may not
  132. apply to you.
  133.  
  134.    Information on contacting the author is provided at the end of this
  135. file.
  136.  
  137.  
  138. 2. USAGE
  139. --------
  140.  
  141.    RAMLIGHT must be called with at least one monitorable drive specified
  142. on the command line. If there are no monitorable drives specified on the
  143. command line, RAMLIGHT will print a message to that effect and exit. See
  144. sections 2.1 and 2.1.1 below for information on what drives are or are
  145. not monitorable.
  146.  
  147.    Note that RAMLIGHT can detect a resident copy of itself and will not
  148. install itself more than once unless the resident copy has been
  149. disabled.
  150.  
  151.  2.1 Monitoring drives
  152.  ---------------------
  153.  
  154.    RAMLIGHT is actually not restricted to monitoring only ramdrives. It
  155. can be used to monitor many sorts of drives; the exceptions are listed
  156. in section 2.1.1 below. Monitoring a drive is simple -- just place the
  157. drive letter followed by a colon on the command line. For example, to
  158. monitor drive E:, all that is needed is:
  159.  
  160.         RAMLIGHT E:
  161.  
  162.    Note that because of the way RAMLIGHT works, sometimes other drives
  163. will be monitored as well. This is because RAMLIGHT monitors by
  164. intercepting calls to device drivers, and some drives share a device
  165. driver. RAMLIGHT detects this condition and prints messages listing
  166. drives which do not appear on the command line which will be monitored.
  167.  
  168.   2.1.1 Unmonitorable drives
  169.   --------------------------
  170.  
  171.    As stated above, RAMLIGHT monitors drives by intercepting calls to
  172. the device driver. Hence, a drive must operate via a normal block-type
  173. device driver for RAMLIGHT to monitor it. Network drives in particular
  174. frequently do not do so, although the same technique may be used for any
  175. type of drive. RAMLIGHT will not monitor any drive which was identified
  176. to DOS as a network drive, and will not monitor any other drive for
  177. which it cannot find a valid block-type device driver.
  178.  
  179.  2.2 Options
  180.  -----------
  181.  
  182.    RAMLIGHT has a variety of options to modify its function. Options are
  183. case-insensitive ("-u" is the same as "-U") and may not be combined.
  184.  
  185.   2.2.1 -u Uninstall
  186.   ------------------
  187.  
  188.    RAMLIGHT can usually uninstall itself. Unless something has been
  189. badly corrupted and it cannot talk to the resident copy, it can always
  190. disable itself, which allows another copy to be installed if necessary.
  191.  
  192.    RAMLIGHT will be unable to uninstall itself if it is not the last TSR
  193. to hook the 10h and 1Ch interrupts, or if the 2Dh AMIS interrupt chain
  194. has been corrupted (see section 3.5). In these cases, it will unhook as
  195. many interrupts as it can and disable itself. Otherwise it unhooks all
  196. the interrupts, disables itself, and remove